CxFmsPPACtrl Properties

The CxFmsPPACtrl object contains the following properties.

General Properties

Property SubType Read Only Description

Appearance

Integer

No

Returns/sets the appearance of the object boundary

Possible values for this property are as follows.

  • 0 – Flat
  • 1 – 3D

Default value is 0 - Flat

BeginDate

String

No

Note: This property is only used if the UseSessionOptions property is set to 0 - No.

Returns/sets the starting date of the FMS PPA control

This string can be in one of the following forms.

  • Absolute date - for example: 1/31/2022
  • Relative date - for example: T (today), T-14 (14 days prior to today), or T+1 (one day following today)

Default value is T-7

BorderStyle

Integer

No

Returns/sets the border style

Possible values for this property are as follows.

  • 0 - None
  • 1 - Fixed single border

Default value is 0 - None

DateFormat

Integer

No

Note: This property is only used if the UseSessionOptions property is set to 0 - No.

Returns/sets the format of the dates shown in the FMS PPA control

Possible values for this property are as follows.

  • 0 – Device_Time
  • 1 – Contract_Time
  • 2 – Local_Time

Default value is 0 - Device_Time

DecimalPrecision

Integer

No

Returns/sets the number of decimal places that will be shown in the values displayed by the FMS PPA control

Acceptable values include 0 -10 decimal places.

Default value is 7

EndDate

String

No

Note: This property is only used if the UseSessionOptions property is set to 0 - No.

Returns/sets the ending date of the FMS PPA control

This string can be in one of the following forms.

  • Absolute date - for example: 1/31/2022
  • Relative date - for example: T (today), T-14 (14 days prior to today), or T+1 (one day following today)

Default value is T

Font

StdFont

No

Returns/sets the font used by the FMS PPA control

Click … to access the Font dialog box to make font selections.

Default value is MS Shell Dlg.

PITDateTime

String

No

Note: This property is only used if the UsePIT property is set to 1 - Yes.

Returns/sets the Point in Time date and time of the FMS PPA control

This string can be in one of the following forms.

  • Absolute Date/Time - for example: 1/31/2022 7:10:14 AM
  • Relative Date/Time - for example: y-1 m-2 d=15 H=5 M=30 S=0
  • Relative Day - an offset from the current day T, for example: T-10

Default value is T, date and time today.

See Using the Home Menu for more information about PIT mode.

SessionBeginDate

String

No

Note: This property is only used if the UseSessionOptions property is set to 1 - Yes.

Returns/sets the Session starting date for the time window displayed in the control

This string can be in one of the following forms.

  • Absolute date - for example: 1/31/2022
  • Relative date - for example: T (today), T-14 (14 days prior to today), or T+1 (one day following today)

Note: Because Session options are universal to all FMS controls, this property can only be set via script during runtime, and the value is not saved to the control.

SessionDateFormat

Integer

No

Note: This property is only used if the UseSessionOptions property is set to 1 - Yes.

Returns/sets the Session date/time format for the time window displayed in the control

Possible values for this property are as follows.

  • 0 – Device_Time
  • 1 – Contract_Time
  • 2 – Local_Time

Note: Because Session options are universal to all FMS controls, this property can only be set via script during runtime, and the value is not saved to the control.

SessionEndDate

String

No

Note: This property is only used if the UseSessionOptions property is set to 1 - Yes.

Returns/sets the Session ending date for the time window displayed in the control

This string can be in one of the following forms.

  • Absolute date - for example: 1/31/2022
  • Relative date - for example: T (today), T-14 (14 days prior to today), or T+1 (one day following today)

Note: Because Session options are universal to all FMS controls, this property can only be set via script during runtime, and the value is not saved to the control.

ShowOptionsPane

Boolean

No

Returns/sets whether or not the Options pane will be displayed in the control

Possible values for this property are as follows.

  • 0 - No
  • 1 - Yes

Default value is 1 - Yes

SiteService

String

No

Returns/sets the Site.Service that will be used by the FMS PPA control

UnitSet

String

No

Returns/sets the unit set used to determine the units of each FMS data item in the FMS PPA control 

Another way to configure this property is to use either the control’s property page or to use the Options page on the FMS Prior Period Adjustment control.

Default value is the <Default> unit set

UsePIT

Boolean

No

Returns/sets whether or not the PITDateTime property will be used

Possible values for this property are as follows.

  • 0 - No
  • 1 - Yes

Default value is 0 - No

UseSessionOptions

Boolean

No

Returns/sets whether or not the SessionBeginDate, SessionEndDate, and SessionDateFormat properties will be used in place of the BeginDate, EndDate, and DateFormat properties

Possible values for this property are as follows.

  • 0 - No
  • 1 - Yes

Default value is 0 - No

Back to top